Local environment variables #252 #366

mtnrbq · 2019-05-26T08:30:26Z

Provide access to local environment variables #252

{{$processEnv [%]envVarName}}: Allows the resolution of local machine environment variables to string values. A typical use case is for secret keys that you don't want to commit to source control.
For example: define shell environment variable
in .bashrc or similar on windows

export DEVSECRET="XlII3JUaEZldVg="
export PRODSECRET="qMTkleUgjclRoRmV1WA=="
export USERNAME="testUser"

and with extension setting environment variables.

"rest-client.environmentVariables": {
    "$shared": {
        "version": "v1"
    },
    "local": {
        "version": "v2",
        "host": "localhost",
        "secretKey": "DEVSECRET"
    },
    "production": {
        "host": "example.com",
        "secretKey" : "PRODSECRET"
    }
}

You can refer directly to the key (e.g. PRODSECRET) in the script, for example if running in the production environment

### Lookup PRODSECRET from local machine environment
GET https://{{host}}/{{version}}/values/item1?user={{$processEnv USERNAME}}
Authorization: {{$processEnv PRODSECRET}}

or, it can be rewritten to indirectly refer to the key using an extension environment setting (e.g. %secret) to be environment independent using the optional % modifier.

### Use secretKey from extension environment settings to determine
### which local machine environment variable to use
GET https://{{host}}/{{version}}/values/item1?user={{$processEnv USERNAME}}
Authorization: {{$processEnv %secret}}

envVarName: Mandatory. Specifies the local machine environment variable

%: Optional. If specified, treats envVarName as an extension setting environment variable, and uses the value of that for the lookup.

Huachao · 2019-05-27T02:14:02Z

@mtnrbq thanks for your nice patch, but please consolidate the variable naming like variable name in code and README, and also fix the tslint errors. Thanks in advance.

mtnrbq · 2019-05-27T02:35:04Z

Will do, can you provide an example re variable naming, so I am clear (I thought I had followed existing, apologies) Get Outlook for Android<https://aka.ms/ghei36>

…

________________________________ From: Huachao Mao <notifications@github.com> Sent: Monday, May 27, 2019 12:14:04 PM To: Huachao/vscode-restclient Cc: mtnrbq; Mention Subject: Re: [Huachao/vscode-restclient] Local environment variables #252 (#366) @mtnrbq<https://github.com/mtnrbq> thanks for your nice patch, but please consolidate the variable naming like variable name in code and README, and also fix the tslint errors. Thanks in advance. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub<#366?email_source=notifications&email_token=AAXERXLACVJKYXRZ5IKRXJTPXM7WZA5CNFSM4HPWFTTKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODWITI7Q#issuecomment-496055422>, or mute the thread<https://github.com/notifications/unsubscribe-auth/AAXERXI4AOHDOUSLVHVYZ33PXM7WZANCNFSM4HPWFTTA>.

Huachao · 2019-05-27T03:01:29Z

@mtnrbq I don't care about the naming convention, my concern is the naming consistency in your own code and doc like following:
In the README, the new system variable name is $processEnvName, while in the source code it seems to be $processEnv. And in the README, the environment variable sample you provided is secretKey, while in the usage part seems to be secret. I just want to make the code and doc no ambiguous.

BTW, still thanks for your great patch.

mtnrbq · 2019-05-27T03:28:46Z

Ahh , got you. All good, and I will address these. I wanted to contribute back, as I've gotten a lot of value from the extension 😃 Get Outlook for Android<https://aka.ms/ghei36>

…

________________________________ From: Huachao Mao <notifications@github.com> Sent: Monday, May 27, 2019 1:01:30 PM To: Huachao/vscode-restclient Cc: mtnrbq; Mention Subject: Re: [Huachao/vscode-restclient] Local environment variables #252 (#366) @mtnrbq<https://github.com/mtnrbq> I don't care about the naming convention, my concern is the naming consistency in your own code and doc like following: In the README, the new system variable name is $processEnvName, while in the source code it seems to be processEnv. And in the README, the environment variable sample you provided is secretKey, while in the usage part seems to be secret. I just want to make the code and doc no ambiguous. BTW, still thanks for your great patch. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub<#366?email_source=notifications&email_token=AAXERXLO2JYOMMZJ5HRS47LPXNFIVA5CNFSM4HPWFTTKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODWIU5II#issuecomment-496062113>, or mute the thread<https://github.com/notifications/unsubscribe-auth/AAXERXJZC3E5FNCZ6EAKO73PXNFIVANCNFSM4HPWFTTA>.

Adjust sync-spin icon and text location

mtnrbq · 2019-05-27T08:15:47Z

@Huachao - documentation updated, and code linted.

Huachao

Why do we need to touch the package-lock.json?

…bq/vscode-restclient into local-environment-variables

mtnrbq · 2019-05-27T22:57:31Z

@Huachao - reverted changes to package-lock and removed spurious space

Huachao · 2019-05-27T09:21:25Z

README.md

@@ -447,10 +451,54 @@ System variables provide a pre-defined set of variables that can be used in any

  `public|cn|de|us|ppe`: Optional. Specify top-level domain (TLD) to get a token for the specified government cloud, `public` for the public cloud, or `ppe` for internal testing. Default: TLD of the REST endpoint; `public` if not valid.

-  `<domain|tenantId>`: Optional. Domain or tenant id for the directory to sign in to. Default: Pick a directory from a drop-down or press `Esc` to use the home directory (`common` for Microsoft Account).
+  `<domain|tenantId>` : Optional. Domain or tenant id for the directory to sign in to. Default: Pick a directory from a drop-down or press `Esc` to use the home directory (`common` for Microsoft Account).


remove space

Space removed

Huachao · 2019-05-27T09:23:02Z

README.md


  `aud:<domain|tenantId>`: Optional. Target Azure AD app id (aka client id) or domain the token should be created for (aka audience or resource). Default: Domain of the REST endpoint.
 * `{{$guid}}`: Add a RFC 4122 v4 UUID
+* `{{$processEnv [%]envVarName}}`: Allows the resolution of local machine environment variables to string values. A typical use case is for secret keys that you don't want to commit to source control.
+For example: define shell environment variable
+in `.bashrc` or similar on windows


Unnecessary to break into two separate lines?

Removed line break

Huachao · 2019-05-27T09:33:49Z

README.md


  `aud:<domain|tenantId>`: Optional. Target Azure AD app id (aka client id) or domain the token should be created for (aka audience or resource). Default: Domain of the REST endpoint.
 * `{{$guid}}`: Add a RFC 4122 v4 UUID
+* `{{$processEnv [%]envVarName}}`: Allows the resolution of local machine environment variables to string values. A typical use case is for secret keys that you don't want to commit to source control.
+For example: define shell environment variable


made singular

Huachao · 2019-05-27T09:34:25Z

README.md

+      "local": {
+          "version": "v2",
+          "host": "localhost",
+          "secretKey": "DEVSECRET"


Now is secretKey in all references

Huachao · 2019-05-27T09:34:37Z

README.md

+      },
+      "production": {
+          "host": "example.com",
+          "secretKey" : "PRODSECRET"


Now is secretKey in all references

Huachao · 2019-05-28T01:33:49Z

README.md

+  ```
+  or, it can be rewritten to indirectly refer to the key using an extension environment setting (e.g. ```%secret```) to be environment independent using the optional ```%``` modifier.
+  ```http
+  ### Use secretKey from extension environment settings to determine


Now is secretKey in all references

Huachao · 2019-05-28T06:24:17Z

@mtnrbq another minor suggestion, add the processEnv system variable into httpElementFactory.ts to enable the autocompletion for it.

Huachao · 2019-05-30T02:48:37Z

@mtnrbq I have added some comments and thanks for your contribution

Huachao · 2019-05-30T04:48:13Z

src/utils/httpVariableProviders/systemVariableProvider.ts

+                return name;
+            }
+        } else {
+        return name;


mtnrbq · 2019-06-01T23:41:17Z

@mtnrbq another minor suggestion, add the processEnv system variable into httpElementFactory.ts to enable the autocompletion for it.

Added as #369

Huachao

Also revert the package-lock.json

Huachao · 2019-06-03T01:41:58Z

README.md

@@ -343,17 +343,19 @@ For environment variables, each environment comprises a set of key value pairs d
    "local": {
        "version": "v2",
        "host": "localhost",
-        "token": "test token"
+        "token": "test token",
+        "secret": "devSecret"


so consolidate with other references

@Huachao - sorry I'm not quite following your comment.
Would it be worthwhile to merge this PR as is and raise new issue on document clarifications?

Package-lock.json reverted

Huachao · 2019-06-03T01:42:19Z

README.md

+  ```http
+  ### Use secretKey from extension environment settings to determine
+  ### which local machine environment variable to use
+<<<<<<< HEAD


merge conflict?

Huachao

Meged, thanks

Robert Mawston added 2 commits May 26, 2019 12:42

Code changes to implement process.env var lookup

0439363

Documentation for processEnvName

3f90b6f

mtnrbq mentioned this pull request May 26, 2019

Support environment variables when resolving values in settings files #252

Closed

robmaw and others added 3 commits May 27, 2019 16:44

tslint fixes

c6f080c

correct documentation of $processEnv

d2892ab

Merge pull request #1 from Huachao/master

88b83f9

Adjust sync-spin icon and text location

Huachao reviewed May 27, 2019

View reviewed changes

robmaw added 3 commits May 28, 2019 08:45

revert changes to package-lock

e686cbd

Merge branch 'local-environment-variables' of https://github.com/mtnr…

ab98c1c

…bq/vscode-restclient into local-environment-variables

remove incorrect space in doco for AAD token

2a3f867

Huachao reviewed May 28, 2019

View reviewed changes

Huachao reviewed May 30, 2019

View reviewed changes

src/utils/httpVariableProviders/systemVariableProvider.ts Outdated

return name;

}

} else {

return name;

Copy link

Owner

Huachao May 30, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

indent

Robert Mawston added 3 commits June 2, 2019 09:26

Improve documentation and sort indentation

8687a78

fix merge conflicts

987c928

Align with changes in master

b8dc545

mtnrbq mentioned this pull request Jun 1, 2019

Enable autocompletion for processEnv system variable #369

Closed

Huachao reviewed Jun 3, 2019

View reviewed changes

Robert Mawston added 2 commits June 4, 2019 18:37

revert package-lock.json - again...

90c6fa8

Remove merge conflict markup

621dff0

Huachao approved these changes Jun 4, 2019

View reviewed changes

Huachao merged commit dd843b8 into Huachao:master Jun 4, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Local environment variables #252 #366

Local environment variables #252 #366

mtnrbq commented May 26, 2019 •

edited

Loading

Huachao commented May 27, 2019

mtnrbq commented May 27, 2019 via email

Huachao commented May 27, 2019 •

edited

Loading

mtnrbq commented May 27, 2019 via email

mtnrbq commented May 27, 2019

Huachao left a comment

mtnrbq commented May 27, 2019

Huachao May 27, 2019

mtnrbq Jun 1, 2019

Huachao May 27, 2019

mtnrbq Jun 1, 2019

Huachao May 27, 2019

mtnrbq Jun 1, 2019

Huachao May 27, 2019

mtnrbq Jun 1, 2019

Huachao May 27, 2019

mtnrbq Jun 1, 2019

Huachao May 28, 2019

mtnrbq Jun 1, 2019

Huachao commented May 28, 2019

Huachao commented May 30, 2019

Huachao May 30, 2019

mtnrbq commented Jun 1, 2019

Huachao left a comment

Huachao Jun 3, 2019

mtnrbq Jun 4, 2019

mtnrbq Jun 4, 2019

Huachao Jun 3, 2019

mtnrbq Jun 4, 2019

Huachao left a comment

Local environment variables #252 #366

Local environment variables #252 #366

Conversation

mtnrbq commented May 26, 2019 • edited Loading

Huachao commented May 27, 2019

mtnrbq commented May 27, 2019 via email

Huachao commented May 27, 2019 • edited Loading

mtnrbq commented May 27, 2019 via email

mtnrbq commented May 27, 2019

Huachao left a comment

Choose a reason for hiding this comment

mtnrbq commented May 27, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Huachao commented May 28, 2019

Huachao commented May 30, 2019

Choose a reason for hiding this comment

mtnrbq commented Jun 1, 2019

Huachao left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Huachao left a comment

Choose a reason for hiding this comment

mtnrbq commented May 26, 2019 •

edited

Loading

Huachao commented May 27, 2019 •

edited

Loading